home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-11 / breeze30.zip / BREEZE.DOC < prev    next >
Text File  |  1993-01-04  |  15KB  |  390 lines
  1.                          THE  B R E E Z E
  2.  
  3.                A TRUE Windowing Library For Clipper
  4.  
  5.     The BREEZE library is NOT a shareware product, nor is it free
  6. software.  This is an evaluation copy of the library, 
  7. functionally it is exactly the same as the copy you will receive 
  8. when you register, however this copy displays a message on the 
  9. screen once, and only once, during the execution of a program.
  10.  
  11.      To Register:
  12.  
  13.          a) Send $75, you will receive the documentation in a printed
  14.             bound manual, or send $50 to receive the latest copy and
  15.             documentation on disk.
  16.          b) If you are interested in customizing this software
  17.             for your's, or your company's own purposes contact
  18.             LOGITEK at 703-486-3518 (leave message) or write to:
  19.  
  20.                    LOGITEK
  21.                    P.O. Box 4603
  22.                    Arlington, Va  22204
  23.  
  24.             Or, leave a message to the SYSOP on the LOGITEK
  25.             BBS at 703 - 450 - 7864 
  26.  
  27.     All registered users will get free technical support from the
  28. LOGITEK BBS.
  29.  
  30.     Feel free to pass this evaluation copy on to as many people
  31. as you would like.
  32.  
  33.     To Register send check  or money order to:
  34.                    LOGITEK
  35.                    P.O. Box 4603
  36.                    Arlington, Va  22204
  37. Unfortunately Logitek cannot accept credit cards as of this time, 
  38. however, at your request we will ship the product to you COD and/or
  39. Express Delivery.
  40.  
  41.  
  42.     LOGITEK is primarily a software products company, 
  43. specializing in microcomputers and primarily using 8086 assembler
  44. and the C language.  However LOGITEK is interested in any 
  45. consulting or custom software that you may require.  LOGITEK
  46. charges on an hourly basis or preferably on a fixed price basis.
  47. No job is too small or too large for LOGITEK !
  48.  
  49.     For Free information call 703 - 486 - 3518 or call the
  50. LOGITEK BBS at 450-7864 and leave a message for the SYSOP.
  51.  
  52.     Future products still in the development stage include:
  53.  
  54.          - Communications Library for Clipper.
  55.  
  56.          - File import/export Library 
  57.  
  58.     Call if you have specific needs or ideas !
  59.  
  60.  
  61.     The following documentation is a VERY sketchy outline of the
  62. functions available in the BREEZE library.  Arguments enclosed in
  63. <>, are optional, and need not be included when calling the 
  64. function.  However arguments must be passed in the correct order,
  65. for example:
  66.  
  67.     wframe(<type frame>,<select area>,<y_left,x_left,y_right,x_right>)
  68.  
  69.     This function's arguments are all optional, however, if you 
  70. want to specify select area, then you must also specify the type 
  71. of frame.  This limitation is beyond the control of this library
  72. and nothing can be done to avoid it.
  73.  
  74.     The linking syntax:
  75.  
  76.     plink86 FI <your file> LIB Clipper,Breeze
  77.  
  78.  
  79.     The program file on this diskette is the demo programs source 
  80. code.
  81.  
  82.  
  83.  
  84. BOX         Draws a box using the extended ASCII character set. 
  85. FUNCTION    This functions allows boxes to be drawn on any video
  86.             page.  Five different types of boxes are available.
  87.  
  88. SYNTAX      box( <y1,x1,y2,x2>,<type>,<page>,<color>) 
  89.  
  90. LINE        LINE draws a single or double bar line between 
  91. FUNCTION    two coordinates on any page of video memory. Two
  92.             types of lines are available.
  93.  
  94. SYNTAX      line(y1,x1,y2,x2,<type>,<boxconn>,<page>,<color>)
  95.  
  96.  
  97. CLEARSCR    CLEARSCR will clear the defined rectangle with the 
  98. FUNCTION    attribute  (color)   specified  in the parameters. 
  99.             If the optional character parameter is specified then
  100.             the rectangle is filled with that character.
  101.  
  102. SYNTAX      clearscr(y1,x1,y2,x2,color,<char>,<page>)
  103.  
  104.  
  105. PRINTSTR    PRINTSTR displays the string at the specified 
  106. FUNCTION    coordinates and page number. This function ONLY 
  107.             prints character data types.
  108.  
  109. SYNTAX      printstr(y1,x1,string,<page>)
  110.      
  111.  
  112. KEYCODE     KEYCODE accepts one input key from the key board.  
  113. FUNCTION    Once a key is pressed KEYCODE returns the scan code 
  114.             for the key, no character is echoed on the screen.
  115.                 
  116. SYNTAX      mem_var = keycode()
  117.  
  118.  
  119. TOGSCR      TOGSCR will turn the monitor on and off.  This will 
  120. FUNCTION    not clear the screen.   The screen can be written to while 
  121.             the monitor is turned off, this is another way to make it 
  122.             appear as if the screen was generated instantly.
  123.  
  124. SYNTAX      togscr(flag)
  125.  
  126.  
  127. SCRMODE     SCRMODE returns the current video mode the computer is
  128. FUNCTION    using.  This function is useful in determining if a 
  129.             computer has a Monochrome Adapter, or a CGA.
  130.  
  131. SYNTAX      mem_var = scrmode()
  132.  
  133.  
  134. SETSCR      SETSCR sets the active display page, this will 
  135. FUNCTION    instantaneously  switch the video display to the desired 
  136.             page.  This  function  is extremely fast  and  is  very 
  137.             efficient for switching pages.  This does  NOT move  the 
  138.             contents  of one video page to another,  but  instead  it 
  139.             directs  the  video  adapter to display the  contents  of 
  140.             another video page. 
  141.  
  142. SYNTAX      setscr(page_num)
  143.  
  144.  
  145. SOUND       SOUND turns the computer's speaker on with the specified 
  146. FUNCTION    frequency, and for the specified duration.  The frequency 
  147.             specified is in kilohertz, and can range from 50 to 15000.  
  148.             The duration is in hundreths of seconds.
  149.  
  150. SYNTAX      sound(freq,duration)
  151.  
  152.  
  153. WUSE        WUSE opens(creates) a window in the current active 
  154. FUNCTION    window select area.  You must specify the number of
  155.             rows (heigth), number of columns (width), and the 
  156.             default coordinate to align the upper left corner of 
  157.             the window on when it is displayed. You must also 
  158.             specify the default color of the window.  This function
  159.             does not display the window on the screen.  If the 
  160.             shaded argument is greater than zero then the window
  161.             will be shaded with the color specified in the 
  162.             shade_color argument.
  163.  
  164. SYNTAX      wuse(rows,columns,yscr,xscr,color,<shaded>,<shade_color>)
  165.  
  166.  
  167. WSELECT     WSELECT selects one of the 99 window areas as the 
  168. FUNCTION    current active window area.  If no select area is 
  169.             specified then the current active select area is 
  170.             returned.  All subsequent windowing functions which do
  171.             not explicitly specify a window area to operate on will
  172.             default to the last window area selected by this function.
  173.  
  174. SYNTAX      wselect(<area>)
  175.  
  176.  
  177. WDISPLAY    Displays a window on the screen, saving the overwritten
  178. FUNCTION    portion of the screen.  All further window operations, 
  179.             WFRAME, WPRINT, WLINE, will only affect the screen image
  180.             of the window.  You can override the window's default
  181.             screen location by specifying a new coordinate to align the
  182.             upper left corner of the window with.  This new coordinate
  183.             will become the default coordinate of this window on all 
  184.             further WDISPLAY functions.
  185.  
  186. SYNTAX      wdisplay(<select area>,<y,x>,<page>)
  187.  
  188.  
  189. WSAVE       WSAVE will write any window to a disk file.  This 
  190. FUNCTION    function along with WRESTORE allows a programmer to create 
  191.             a virtual window/screen system, releasing the programmer 
  192.             from the confines of memory space.
  193.  
  194. SYNTAX      wsave(filename,<select area>)
  195.  
  196.  
  197. WRESTORE    WRESTORE creates a window and reads the window residing in 
  198. FUNCTION    the specified file into the newly created window.
  199.  
  200. SYNTAX      wrestore(filename,<select area>)
  201.  
  202.  
  203. WCOLOR      WCOLOR changes the default color of the window, if the 
  204. FUNCTION    optional <change flag> is specified then all of the 
  205.             attributes (colors) in a given window will be changed to 
  206.             the specified color.  This function will not disturb any 
  207.             information that is currently in the window, it ONLY 
  208.             changes the colors.
  209.  
  210. SYNTAX      wcolor(color,<change flag>,<select area>)
  211.  
  212.  
  213. WCLEAR      WCLEAR will clear any rectangle within a window, and make
  214. FUNCTION    that rectangle the specified color.  If the optional 
  215.             character is specified then the rectangle will be filled
  216.             with that character.
  217.  
  218. SYNTAX      wclear(<y1,x1,y2,x2>,<color>,<character>,<select area>)
  219.  
  220.  
  221. WPRINT      WPRINT displays the string at the coordinates on the  
  222. FUNCTION    window specified.  This function ONLY prints character
  223.             data types.  This function will automatically perform a 
  224.             'smart' wordwrap.  If the string is too large for the window
  225.             WPRINT will attempt to break the string at the nearest
  226.             space, and will return unprinted portion of the string
  227.             as the function's return value.  WPRINT returns a null
  228.             character, ( "" ) if the string fits inside the window.
  229.             Additionally this function will never print a character on
  230.             in the last column of a window, this will insure that the
  231.             window's frame will never be overwritten.
  232.  
  233. SYNTAX      wprint(y1,x1,str,<select area>)
  234.      
  235.  
  236. WFRAME      Draws a box around the window using the ASCII box
  237. FUNCTION    characters. This function will draw five different 
  238.             types of frames around a window, and if the optional 
  239.             parameters are specified WFRAME will draw a box anywhere 
  240.             on the window.  The color defaults to the current window's
  241.             color
  242.  
  243. SYNTAX      wframe(<type>,<select area>,<y1,x1,y2,x2>)
  244.  
  245.  
  246. WLINE       WLINE draws a single or double bar line between given 
  247. FUNCTION    two coordinates on the specified window.  Optional box
  248.             connector character can also be specified.
  249.  
  250. SYNTAX      wline(y1,x1,y2,x2,<type>,<boxconn>,<select area>)
  251.  
  252.  
  253. WCLOSE      WCLOSE will close the specified window, and restore the
  254. FUNCTION    previously overwritten portion of the screen.  This will
  255.             basically make the window only active in memory, not on the
  256.             screen.  If the optional update flag is specified, then any
  257.             thing that is being displayed on the window when it is 
  258.             will be copied to the window in memory.
  259.  
  260. SYNTAX      wclose(<select area>,<update flag>)
  261.  
  262.  
  263. WCOPY       WCOPY copies the selected window to another window,
  264. FUNCTION    aligning the upper left corner of the copied window with
  265.             the given coordinate on the target window. 
  266.  
  267. SYNTAX      wcopy(y,x,target area,<source area>)
  268.  
  269.  
  270. WRELEASE    WRELEASE will release a window from memory.  If the window
  271. FUNCTION    is currently on the screen, the saved portion of the screen
  272.             will be lost.  If no parameters are given then the current
  273.             active window will be released.
  274.  
  275. SYNTAX      wrelease(<select area>)
  276.  
  277.  
  278. WMOVFROM    WMOVFROM copies a portion of a window to the screen. 
  279. FUNCTION    The first four parameters define the area on the window
  280.             to be copied, the sixth and seventh parameters specify the
  281.             coordinate to align the upper left corner of the moved
  282.             rectangle with.  If a rectangle is larger than the screen 
  283.             it will be automatically clipped.  Note that this function
  284.             does NOT save the overwritten area on the screen.  WMOVFROM
  285.             can copy a portion of a window to ANY video page.  If no
  286.             parameters are specified then the entire window is copied
  287.             to the screen, aligned on the upper left corner of the 
  288.             screen.  If ONLY a single (x,y) coordinate is specified
  289.             then the entire window is move to the screen aligned on 
  290.             the given coordinate.
  291.  
  292. SYNTAX      wmovfrom(<y1,x1,y2,x2>,<select area>,<y3,x3>,<page>)
  293.  
  294.  
  295. WMOVETO     WMOVETO copies a portion of the screen to a window. 
  296. FUNCTION    The first four parameters define the area on the screen
  297.             to be copied, the sixth and seventh parameters specify the
  298.             coordinate to align the upper left corner of the moved
  299.             rectangle with.  If a rectangle is larger than the window
  300.             it will be automatically clipped. WMOVETO can copy a portion 
  301.             of ANY video page.  If no parameters are specified then the 
  302.             entire screen is copied to the current window area aligned on
  303.             the window coordinate 0,0.
  304.  
  305. SYNTAX      wmoveto(<y1,x1,y2,x2>,<select area>,<y3,x3>,<page>)
  306.  
  307.  
  308. WSCROLL     WSCROLL scrolls within a window when the window is displayed
  309. FUNCTION    on the screen.  This function can scroll any number of lines,
  310.             up, down, left or right.  WSCROLL will automatically adjust 
  311.             if the window is framed, so that the frame is not disturbed.
  312.  
  313. SYNTAX      wscroll(<nolines>,<up/down>,<select area>,<y1,x1,y2,x2>)
  314.  
  315.  
  316. WSHIFT      WSHIFT moves a window that is currently on the screen, one
  317. FUNCTION    column or row in any direction.
  318.  
  319. SYNTAX      wshift(direction,<update flag>,<select area>)
  320.  
  321.  
  322. WCOLUMN     WCOLUMN returns the number of columns, the width, of 
  323. FUNCTION    a window.
  324.  
  325. SYNTAX      wcolumn(<select area>)
  326.  
  327.  
  328. WROW        WROW returns the number of rows, the heigth, of 
  329. FUNCTION    a window.
  330.  
  331. SYNTAX      wrow(<select area>)
  332.  
  333. WCOLSCR     WCOLSCR returns the current screen coordinate of the
  334. FUNCTION    window.
  335.  
  336. SYNTAX      wcolscr(<select area>)
  337.  
  338.  
  339. WROWSCR     WROWSCR returns the current screen coordinate of the
  340. FUNCTION    window.
  341.  
  342. SYNTAX      wrowscr(<select area>)
  343.  
  344. WFILL       WFILL will fill any portion of a window with the color
  345. FUNCTION    specified.  This function does not disturb the info in
  346.             the window, but rather only changes the color.
  347.  
  348. SYNTAX      wfill(y1,x1,y2,x2,color,<select area>)
  349.  
  350.  
  351. WFIND       WFIND will return the next free window select area, optionall
  352. FUNTION     starting its search at the select area specified, this argument
  353.             defaults to select area one.
  354.  
  355. SYNTAX      wfind(<start area>)
  356.  
  357.  
  358. WEXIST      WEXIST returns true if the specified select area is in use,
  359. FUNCTION    otherwise it returns false.  Select area defaults to current
  360.             window select area.
  361.  
  362. SYNTAX      wexist(<select area>)
  363.  
  364.  
  365. WZOOM       WZOOM turns the zoom function on/off for the specified window.
  366. FUNCTION
  367.  
  368. SYNTAX      wzoom(freq,delay,factor,<select area>)
  369.  
  370.  
  371. ZOOM        ZOOM turns the zoom function on/off for the specified window.
  372. FUNCTION
  373.  
  374. SYNTAX      zoom(y1,x1,y2,x2,color,freq,delay,factor)
  375.  
  376.  
  377. DELAY       DELAY delays the program for the specified number of timer
  378. FUNCTION    'tics'.  A timer tic is machine independent and is equal
  379.             to approximately 55ms.
  380.  
  381. SYNTAX      delay(tics)
  382.  
  383.  
  384. SHADE       SHADE clears the specified area and uses shade characters
  385. FUNCTION    around the right and bottom edges to give the rectangle
  386.             a 3-D look.
  387.  
  388. SYNTAX      shade(y1,x1,y2,x2,color1,color2,width)
  389.  
  390.